Skip to content
11 changes: 11 additions & 0 deletions src/libponyc/pkg/package.c
Original file line number Diff line number Diff line change
Expand Up @@ -1052,15 +1052,26 @@ ast_t* package_load(ast_t* from, const char* path, pass_opt_t* opt)
return NULL;
} else if(magic->mapped_path != NULL) {
if(!parse_files_in_dir(package, magic->mapped_path, opt))
{
ast_setflag(package, AST_FLAG_PRESERVE);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could use a brief comment here. Even just a pointer to the comment on the other branch below so someone reading this code path doesn't have to go hunting for why the flag is being set.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ping on this.

return NULL;
}
} else {
return NULL;
}
}
else
{
if(!parse_files_in_dir(package, full_path, opt))
{
// If source file parsing failed, don't run future passes on the
// partially-initialised package. Without this, passes that run on the
// whole program tree (e.g. the scope pass) would visit modules that
// were successfully parsed in this package but whose for-loop sugar
// has not been applied, producing spurious errors in those files.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The comment here ties the explanation to for-loop sugar, but the underlying problem is more general. Any pass running on a partially-processed package could produce spurious errors. The for-loop case is just how this manifested in #4160. I'd drop the for-loop detail and keep it general — "producing spurious errors in those files" is enough. The for-loop specifics are better suited to the commit message where they're tied to the issue report.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ping

ast_setflag(package, AST_FLAG_PRESERVE);
return NULL;
}
}

if(ast_child(package) == NULL)
Expand Down
3 changes: 3 additions & 0 deletions test/libponyc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,16 @@ target_include_directories(libponyc.tests
)

set(PONY_PACKAGES_DIR "${CMAKE_SOURCE_DIR}/packages")
set(PONY_TEST_LIBPONYC_DIR "${CMAKE_SOURCE_DIR}/test/libponyc")

if (MSVC)
string(REPLACE "/" "\\\\" PONY_PACKAGES_DIR ${PONY_PACKAGES_DIR})
string(REPLACE "/" "\\\\" PONY_TEST_LIBPONYC_DIR ${PONY_TEST_LIBPONYC_DIR})
endif (MSVC)

target_compile_definitions(libponyc.tests
PRIVATE PONY_PACKAGES_DIR="${PONY_PACKAGES_DIR}"
PRIVATE PONY_TEST_LIBPONYC_DIR="${PONY_TEST_LIBPONYC_DIR}"
)

target_link_directories(libponyc.tests
Expand Down
27 changes: 27 additions & 0 deletions test/libponyc/badpony.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1446,3 +1446,30 @@ TEST_F(BadPonyTest, MatchArrayPatternWithBareIntegerLiterals)
"couldn't find 'eq' in 'Array'",
"this pattern element doesn't support structural equality");
}

TEST_F(BadPonyTest, SpuriousErrorMessageGeneration)
{
// From issue #4160
// A parse error in one file of a package must not produce spurious
// "can't reuse name" errors in other files of the same package that
// reuse a loop variable name across consecutive for loops.
// The fixture package has two files: bad.pony (parse error) comes before
// good.pony (valid, with consecutive "for i" loops) alphabetically.
add_package_path("pkg", PONY_TEST_LIBPONYC_DIR "/fixtures/spurious-error-message-generation");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

im not a fan of adding fixtures to a testing style we are trying to move away from. @jemc what are your thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree about not adding this new external file fixture mechanism in this PR. These should be inlined, and if we wanted to discuss external file fixtures we could discuss adding them in an issue ticket outside the scope of this PR.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

What are the conclusions?

  • No regression test?
  • Change the magic package to support multiple sources?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we are ok with dropping this test. we think it is the most preferable of the options here.

const char* src =
"use \"pkg\"\n"
"actor Main\n"
" new create(env: Env) =>\n"
" for i in Range(0, 3) do\n"
" None\n"
" end\n"
" for i in Range(0, 3) do\n"
" None\n"
" end";

TEST_ERRORS_2(src,
"syntax error: unexpected token = after type, interface, trait, primitive,"
" class or actor definition",
"can't load package 'pkg'");
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Intentional syntax error: = instead of =>
class Bad
new create() =
None
16 changes: 16 additions & 0 deletions test/libponyc/fixtures/spurious-error-message-generation/good.pony
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Syntactically valid file in the same package as bad.pony.
// The loop variable 'i' is reused across consecutive for loops; before the
// fix for issue #4160, a parse error in bad.pony caused spurious
// "can't reuse name 'i'" errors here.
class Good
new create() =>
let a: Array[U8] = Array[U8]
for i in a.values() do
None
end
for i in a.values() do
None
end
for i in a.values() do
None
end
6 changes: 6 additions & 0 deletions test/libponyc/util.cc
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,12 @@ void PassTest::add_package(const char* path, const char* src)
}


void PassTest::add_package_path(const char* path, const char* real_dir)
{
package_add_magic_path(path, real_dir, &opt);
}


void PassTest::default_package_name(const char* path)
{
_first_pkg_path = path;
Expand Down
3 changes: 3 additions & 0 deletions test/libponyc/util.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ class PassTest : public testing::Test
// Add an additional package source
void add_package(const char* path, const char* src);

// Add an additional package backed by a real filesystem directory
void add_package_path(const char* path, const char* real_dir);

// Override the default path of the main package (useful for package loops)
void default_package_name(const char* path);

Expand Down
Loading