Errata and boilerplate #7

gkellogg · 2023-01-27T23:41:41Z

This addresses #4, other than the unresolved issues about IRIs.

💥 Error: 500 Internal Server Error 💥

PR Preview failed to build. (Last tried on Jan 30, 2023, 10:55 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 Spec Generator - Spec Generator is the web service used to build specs that rely on ReSpec.


😭  Sorry, there was an error generating the HTML. Please report this issue!
Specification: http://labs.w3.org/spec-generator/uploads/WerS0g/spec/index.html?isPreview=true%3FisPreview%3Dtrue&publishDate=2023-01-30
ReSpec version: 32.6.1
File a bug: https://github.com/w3c/respec/
Error: Error: Evaluation failed: Timeout: document.respec.ready didn't resolve in 28248ms.
    at ExecutionContext._ExecutionContext_evaluate (/u/spec-generator/node_modules/puppeteer-core/lib/cjs/puppeteer/common/ExecutionContext.js:229:15)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async ExecutionContext.evaluate (/u/spec-generator/node_modules/puppeteer-core/lib/cjs/puppeteer/common/ExecutionContext.js:107:16)
    at async generateHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:221:12)
    at async toHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:92:18)
    at async Object.generate [as respec] (file:///u/spec-generator/generators/respec.js:15:44)
    at async file:///u/spec-generator/server.js:252:48

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

gkellogg · 2023-01-27T23:52:24Z

Still seeing ReSpec errors even after commenting out the section that seemed to be the problem. Can't reproduce on my own system. This is also apparently preventing PR preview from running. Could the addition of submodules play a role?

gkellogg · 2023-01-27T23:59:16Z

Note, the timeout is from https://labs.w3.org/spec-generator/, when using https://raw.githubusercontent.com/w3c/rdf-concepts/errata-and-boilerplate/spec/index.html. Says to file a bug, which it may come to.

Sorry, there was an error generating the HTML.
Please report this issue!
Specification: http://labs.w3.org/spec-generator/uploads/6dGzrm/spec/index.html?publishDate=2023-01-27
ReSpec version: 32.6.1
File a bug: https://github.com/w3c/respec/
Error: Error: Evaluation failed: Timeout: document.respec.ready didn't resolve in 28671ms.
    at ExecutionContext._ExecutionContext_evaluate (/u/spec-generator/node_modules/puppeteer-core/lib/cjs/puppeteer/common/ExecutionContext.js:229:15)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async ExecutionContext.evaluate (/u/spec-generator/node_modules/puppeteer-core/lib/cjs/puppeteer/common/ExecutionContext.js:107:16)
    at async generateHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:221:12)
    at async toHTML (/u/spec-generator/node_modules/respec/tools/respecDocWriter.js:92:18)
    at async Object.generate [as respec] (file:///u/spec-generator/generators/respec.js:15:44)
    at async file:///u/spec-generator/server.js:252:48

afs

One comment - not blocking.

Process-wise this PR looks good.

spec/index.html

gkellogg · 2023-01-28T20:35:29Z

I’ve been trying to track down why the GH Actions build fails, and why PR Preview also fails. It seems the the problem started when we introduced the git submodule for /spec/common. I note that the https://w3c.github.com/rdf-concepts/spec link renders okay, but not through either GitHack or W3c spec-generator using the raw file view.

The pre-submodule version renders fine, the “main” version errors with a timeout. I just marked the last commit prior to using the submodule as the branch "pre-submodule" just for this purpose.

PR Preview uses spec-generator, so that’s why it fails. I’m not sure why respec fails in the GH Action, but it must be due to the same problem. While there might be something we could do in the GH Action config to address this, there’s really nothing we can do about PR Preview and spec-generator.

I wasn’t able to see anything posted about this through a Google search, so it might not be a completely understood problem, but the fact that GitHack fails the same way suggests there’s probably nothing that can really be done. We may be faced with the prospect of undoing the recent change to use Git submodules, unfortunately.

Tpt · 2023-01-29T17:38:13Z

@gkellogg: This might help: #8

…Concepts (dated refernece for 1.0, as RDF10-CONCEPTS is not defined).

Co-authored-by: Andy Seaborne <[email protected]>

gkellogg · 2023-01-29T18:40:48Z

Thanks @Tpt, that helped the GH Action get further, but PR Preview seems to continue to fail. Notably, spec-generator (used by PR Preview) still fails, as it doesn't have visibility to the submodule, apparently. Running spec-generator using the pre-submodule branch does work.

pchampin

Appart from losing the previous contributors, LGTM

pchampin · 2023-01-30T11:54:14Z

spec/index.html

-<section class="appendix informative" id="changes">
-  <h2>Changes between RDF 1.0 and RDF 1.1</h2>
+  <p>The following people have contributed to this specification:
+    <span id="gh-contributors"></span>


A number of the previously listed people will not be listed anymore... I think that's a shame...

Apart from that, that's a super cool feature of Respec hat I didn't know about ;-)

We certainly need to figure out how to deal with 1.1 contributors, in addition to 1.0. A reference to the contributors section in the previous spec(s) would be one way, or multiple contributor sections. Ultimately, this could prove to be difficult to manage. But, I think it’s a group decision on how to recognize previous contributions. Note that we do maintain a list of Former Editors separately.

I think @iherman had a script to get the current WG membership and create a list for inclusion automatically.

similarly, what level of the “previous changes” do we try to maintain? Some have a lot of transition detail (WD, CR, PR, REC) that isn’t as pertinent now.

@gkellogg I think what you referred to is here:

https://github.com/w3c/publ_ack

I have not looked at the script for a while, because recent groups that I worked with had their own way of creating the list of acknowledgements, but I presume it is still operational...

Just came up with this using the W3C API: w3c/rdf-common#3. (With an assist from ChatGPT).

Yep, that is what my script uses as well!

…ack documents.

… in an ednote about retrieving WG participants from group page.

…tionalization Considerations" sections. Security Considerations taken from N-Triples, but made more generic.

…ce to #9 for future resolution.

TallTed · 2023-01-30T23:50:35Z

spec/index.html

+    Application rendering strings retrieved from untrusted RDF documents must ensure
+    that malignant strings may not be used to mislead the reader.


I don't believe this requirement can be satisfied by any applications available today, if ever.

As things stand, humans must take care to load varyingly trustworthy RDF into appropriately partitioned data stores (typically, using named graphs), and to execute queries across "all data in the store" only when recognizing that results may include malicious, erroneous, or otherwise undesirable statements (whether triples or quads).

Such undesirable results are not the responsibility of any software in the stack.

It's taken right out of the Turtle IANA Considerations section

Turtle can express data which is presented to the user, for example, RDF Schema labels. Application rendering strings retrieved from untrusted Turtle documents must ensure that malignant strings may not be used to mislead the reader. The security considerations in the media type registration for XML ([RFC3023] section 10) provide additional guidance around the expression of arbitrary data and markup.

I didn't want to try to tread new ground here, but ReSpec demands that specs have such a section, and this seemed to apply generally to RDF serializations. I also don't want to revisit the IANA registrations of Turtle/TriG/N-Triples/N-Quads which already have such considerations, and it would be inconsistent to say something different.

Wow. As I understand things, that means that zero current implementations of Turtle/TriG/N-Triples/N-Quads functionality are spec compliant, because none can "ensure that malignant strings may not be used to mislead the reader" — there's just no way to do so!

The text should say "Applications" to be clearer as it does a little further up.

The text is in a section titled "Security considerations" - things applications need to consider. It's not compliance.

Parsers aren't applications and don't render strings.
Applications choose to use parsers and data and the applications are responsible for the usage and so responsible for misleading the user.

The text is an obligation and noteworthy point on the use of the data.

Followups to this thread should go on #11.

spec/index.html

TallTed · 2023-01-31T00:03:24Z

spec/index.html

+
+<section id="internationalization">
+  <h2>Internationalization Considerations</h2>
+  <p>RDF is restricted to representing string values with -to-right or right-to-left direction indicators.


Suggested change

<p>RDF is restricted to representing string values with -to-right or right-to-left direction indicators.

<p>RDF is restricted to representing string values with left-to-right or right-to-left direction indicators.

Co-authored-by: Ted Thibodeau Jr <[email protected]>

gkellogg · 2023-01-31T20:34:27Z

Closing in favor of #10, which incorporates suggestions. Discussions of Security Considerations may need to be a new issue potentially resulting in another PR, but it is a meta-issue affecting at least four other specs.

gkellogg requested review from afs and pchampin January 27, 2023 23:41

afs approved these changes Jan 28, 2023

View reviewed changes

spec/index.html Outdated Show resolved Hide resolved

gkellogg and others added 5 commits January 29, 2023 10:28

Address erratum 13 by referencing both RDF 1.1 Concepts, and RDF 1.0 …

c136e34

…Concepts (dated refernece for 1.0, as RDF10-CONCEPTS is not defined).

Contributors and acknowledgments.

2a04236

Add issue on normative reference to RFC3987 for IRIs.

d3e56f3

Comment out term index until w3c/respec#4362 is addressed.

59562b6

Update spec/index.html

578d6ff

Co-authored-by: Andy Seaborne <[email protected]>

gkellogg force-pushed the errata-and-boilerplate branch from baec7f9 to 578d6ff Compare January 29, 2023 18:29

pchampin requested changes Jan 30, 2023

View reviewed changes

gkellogg added 5 commits January 30, 2023 11:40

Update common submodule version.

bfbbd5d

Use gkellogg as interim editor, since ReSpec needs a w3cid for rec-tr…

a966232

…ack documents.

Restore 1.1 acknowledgments and changes. Add 1.0 acknowledgments. Put…

c7714ec

… in an ednote about retrieving WG participants from group page.

Add "Privacy Considerations", "Security Considerations", and "Interna…

d2b7791

…tionalization Considerations" sections. Security Considerations taken from N-Triples, but made more generic.

Add text for Internationalization Considerations, including a referen…

a92d8ea

…ce to #9 for future resolution.

TallTed reviewed Jan 30, 2023

View reviewed changes

spec/index.html Outdated Show resolved Hide resolved

TallTed reviewed Jan 31, 2023

View reviewed changes

spec/index.html Outdated Show resolved Hide resolved

TallTed reviewed Jan 31, 2023

View reviewed changes

Apply suggestions from code review

61e9f62

Co-authored-by: Ted Thibodeau Jr <[email protected]>

gkellogg mentioned this pull request Jan 31, 2023

Errata and boilerplate with reverted submodule #10

Merged

TallTed mentioned this pull request Jan 31, 2023

zero current implementations of Turtle/TriG/N-Triples/N-Quads functionality are spec compliant, because none can "ensure that malignant strings may not be used to mislead the reader" — there's just no way to do so! #11

Closed

gkellogg closed this Jan 31, 2023

gkellogg deleted the errata-and-boilerplate branch February 1, 2023 23:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Errata and boilerplate #7

Errata and boilerplate #7

gkellogg commented Jan 27, 2023 •

edited by pr-preview bot

Loading

gkellogg commented Jan 27, 2023

gkellogg commented Jan 27, 2023

afs left a comment

gkellogg commented Jan 28, 2023

Tpt commented Jan 29, 2023

gkellogg commented Jan 29, 2023

pchampin left a comment

pchampin Jan 30, 2023

pchampin Jan 30, 2023

gkellogg Jan 30, 2023

iherman Jan 31, 2023

gkellogg Jan 31, 2023

iherman Jan 31, 2023

TallTed Jan 30, 2023

gkellogg Jan 31, 2023

TallTed Jan 31, 2023

afs Jan 31, 2023

TallTed Feb 1, 2023

TallTed Jan 31, 2023

gkellogg commented Jan 31, 2023

		Application rendering strings retrieved from untrusted RDF documents must ensure
		that malignant strings may not be used to mislead the reader.

	<p>RDF is restricted to representing string values with -to-right or right-to-left direction indicators.
	<p>RDF is restricted to representing string values with left-to-right or right-to-left direction indicators.

Errata and boilerplate #7

Errata and boilerplate #7

Conversation

gkellogg commented Jan 27, 2023 • edited by pr-preview bot Loading

💥 Error: 500 Internal Server Error 💥

gkellogg commented Jan 27, 2023

gkellogg commented Jan 27, 2023

afs left a comment

Choose a reason for hiding this comment

gkellogg commented Jan 28, 2023

Tpt commented Jan 29, 2023

gkellogg commented Jan 29, 2023

pchampin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gkellogg commented Jan 31, 2023

gkellogg commented Jan 27, 2023 •

edited by pr-preview bot

Loading