Skip to content

Commit

Permalink
added roundtrip test
Browse files Browse the repository at this point in the history
  • Loading branch information
@PankajBhojwani
PankajBhojwani committed Aug 28, 2020
1 parent 5dcd706 commit a099fc7
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 4 deletions.
11 changes: 8 additions & 3 deletions src/buffer/out/textBuffer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2299,6 +2299,11 @@ uint16_t TextBuffer::GetHyperlinkId(std::wstring_view params)
}
id = (*(result.first)).second;
}
// _currentHyperlinkId could overflow, make sure its not 0
if (_currentHyperlinkId == 0)
{
++_currentHyperlinkId;
}
return id;
}

Expand Down Expand Up @@ -2343,8 +2348,8 @@ std::wstring TextBuffer::GetCustomIdFromId(uint16_t id) const
// - Copies the hyperlink/customID maps of the old buffer into this one
// Arguments:
// - The other buffer
void TextBuffer::CopyHyperlinkMaps(const TextBuffer& OtherBuffer)
void TextBuffer::CopyHyperlinkMaps(const TextBuffer& other)
{
_hyperlinkMap = OtherBuffer._hyperlinkMap;
_hyperlinkCustomIdMap = OtherBuffer._hyperlinkCustomIdMap;
_hyperlinkMap = other._hyperlinkMap;
_hyperlinkCustomIdMap = other._hyperlinkCustomIdMap;
}
2 changes: 1 addition & 1 deletion src/cascadia/TerminalControl/TermControl.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2849,7 +2849,7 @@ namespace winrt::Microsoft::Terminal::TerminalControl::implementation
// - The uri
void TermControl::_HyperlinkHandler(const std::wstring_view uri)
{
auto hyperlinkArgs = winrt::make_self<OpenHyperlinkEventArgs>(winrt::hstring(uri));
auto hyperlinkArgs = winrt::make_self<OpenHyperlinkEventArgs>(winrt::hstring{ uri });
_openHyperlinkHandlers(*this, *hyperlinkArgs);
}

Expand Down
69 changes: 69 additions & 0 deletions src/cascadia/UnitTests_TerminalCore/ConptyRoundtripTests.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ class TerminalCoreUnitTests::ConptyRoundtripTests final

TEST_METHOD(DeleteWrappedWord);

TEST_METHOD(HyperlinkIdConsistency);

private:
bool _writeCallback(const char* const pch, size_t const cch);
void _flushFirstFrame();
Expand Down Expand Up @@ -3471,3 +3473,70 @@ void ConptyRoundtripTests::DeleteWrappedWord()
Log::Comment(L"========== Checking the terminal buffer state (after) ==========");
verifyBuffer(*termTb, term->_mutableViewport.ToInclusive(), true);
}

// This test checks that upon conpty rerendering, terminal still maintains
// the same hyperlink IDs
void ConptyRoundtripTests::HyperlinkIdConsistency()
{
Log::Comment(NoThrowString().Format(
L"Write a link - the text will simply be 'Link' and the uri will be 'http://example.com'"));

auto& g = ServiceLocator::LocateGlobals();
auto& renderer = *g.pRender;
auto& gci = g.getConsoleInformation();
auto& si = gci.GetActiveOutputBuffer();
auto& hostSm = si.GetStateMachine();
auto& hostTb = si.GetTextBuffer();
auto& termTb = *term->_buffer;

_flushFirstFrame();

hostSm.ProcessString(L"\x1b]8;;http://example.com\x1b/Link\x1b]8;;\x1b/");

// For self-generated IDs, conpty will send a custom ID of the form
// {sessionID}-{self-generated ID}
// self-generated IDs begin at 1 and increment from there
const std::string fmt{ "\x1b]8;id={}-1;http://example.com\x1b\\" };
auto s = fmt::format(fmt, GetCurrentProcessId());
expectedOutput.push_back(s);
expectedOutput.push_back("Link");
expectedOutput.push_back("\x1b]8;;\x1b\\");

// Force a frame
VERIFY_SUCCEEDED(renderer.PaintFrame());

// Move the cursor down
hostSm.ProcessString(L"\x1b[2;1H");
expectedOutput.push_back("\r\n");

// Force a frame
VERIFY_SUCCEEDED(renderer.PaintFrame());

// Move the cursor to somewhere in the link text
hostSm.ProcessString(L"\x1b[1;2H");
expectedOutput.push_back("\x1b[1;2H");
expectedOutput.push_back("\x1b[?25h");

// Force a frame
VERIFY_SUCCEEDED(renderer.PaintFrame());

// Move the cursor off the link
hostSm.ProcessString(L"\x1b[2;1H");
expectedOutput.push_back("\r\n");

// Force a frame
VERIFY_SUCCEEDED(renderer.PaintFrame());

auto verifyData = [](TextBuffer& tb) {
// Check that all the linked cells still have the same ID
auto attrRow = tb.GetRowByOffset(0).GetAttrRow();
auto id = attrRow.GetAttrByColumn(0).GetHyperlinkId();
for (auto i = 1; i < 4; ++i)
{
VERIFY_ARE_EQUAL(id, attrRow.GetAttrByColumn(i).GetHyperlinkId());
}
};

verifyData(hostTb);
verifyData(termTb);
}

1 comment on commit a099fc7

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New misspellings found, please review:

  • rerendering
To accept these changes, run the following commands 
perl -e '
my @expect_files=qw('".github/actions/spell-check/expect/alphabet.txt
.github/actions/spell-check/expect/expect.txt
.github/actions/spell-check/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"Autogenerated debugbreak DECLL DECSMBV Inplace notypeopt restrictederrorinfo Scs Wlk "');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
  if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
  next if /^($re)(?:$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spell-check/expect/a099fc74657242224a9b1fb57c736f23e76d1d60.txt";
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"autogenerated inplace rerendering "');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a) cmp lc($b)} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;'
git add .github/actions/spell-check/expect || echo '... you want to ensure .github/actions/spell-check/expect/a099fc74657242224a9b1fb57c736f23e76d1d60.txt is added to your repository...'
✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spell-check/dictionary/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spell-check/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spell-check/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The :check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

Please sign in to comment.