Fix multiple small (but sometimes serious) issues #1144

oturpe · 2021-07-25T10:37:41Z

Master branch has multiple issues small (but sometimes very serious).

Vagrant development environment setup failed during 'vagrant up'

Errors during from task Build the Anitya documentation:

user-guide.rst:210:Inline strong start-string without end-string.
user-guide.rst:3:Duplicate explicit target name: "sourceforge.net"

Like the errors say, the entry about Sourceforge (git) was corrupted
in two different ways:

Strong string was started with **, but never terminated.
The fix is obvious.
The same document had two links using format '`text `_',
which is not allowed in reStructured Text.
Fixed by using '__' in the second link, making it "anonymous".

Fix corrupted javascript

Caused the page it was on malfunction in serious ways.

Display error correctly when Test Check fails

When Test Check failed in the Edit Project page,
resulting error was displayed as '[Object object]'.
This was a result of concatenating an object to string.
Fixed by using JSON.stringify().

softwarefactory-project-zuul · 2021-07-25T10:47:44Z

Build succeeded.

tox-lint : SUCCESS in 4m 02s
tox-format : SUCCESS in 4m 05s
tox-python37 : SUCCESS in 7m 56s
tox-python38 : SUCCESS in 9m 33s
anitya-tox-docs : SUCCESS in 5m 09s
tox-bandit : SUCCESS in 4m 27s
tox-diff-cover : SUCCESS in 7m 41s

softwarefactory-project-zuul · 2021-07-25T17:52:46Z

Build succeeded.

tox-lint : SUCCESS in 5m 17s
tox-format : SUCCESS in 3m 40s
tox-python37 : SUCCESS in 9m 11s
tox-python38 : SUCCESS in 7m 14s
anitya-tox-docs : SUCCESS in 4m 32s
tox-bandit : SUCCESS in 3m 51s
tox-diff-cover : SUCCESS in 7m 00s

softwarefactory-project-zuul · 2021-07-25T19:15:19Z

Build succeeded.

tox-lint : SUCCESS in 3m 39s
tox-format : SUCCESS in 3m 42s
tox-python37 : SUCCESS in 7m 33s
tox-python38 : SUCCESS in 7m 27s
anitya-tox-docs : SUCCESS in 4m 45s
tox-bandit : SUCCESS in 3m 49s
tox-diff-cover : SUCCESS in 7m 07s

Zlopez

The changes are looking good, could you just add a news file to this PR?

Name it PR1144.bug and add it to news folder. The text could be something like Fix documentation and javascript issue`

Zlopez · 2021-07-26T07:51:13Z

docs/user-guide.rst

@@ -207,8 +207,8 @@ The backends available are:
  You need to provide **Sourceforge name** if the name on RSS feed is different then the
  project name on Sourceforge.

-* **Sourceforge (git) for projects hosted on
-  `sourceforge.net <https://sourceforge.net>`_
+* **Sourceforge (git)** for projects hosted on


I'm surprised this wasn't caught by the tests. It was recently added in #1134.

I was too. I looked at it again, Zuul configuration is wrong,
job anitya-tox-docs is actually running Bandit.
Probably just a copy paste error and easy to fix?

Otherwise, Vagrant uses the Makefile in the docs folder
while Zuul runs some commands embedded inside tox.ini.
That could cause varying results, too.

- job: name: anitya-tox-docs ... parent: tox run: ci/test-tox.yaml vars: tox_env: bandit ...

This really looks like a copy paste error on my side. I will fix it. I will also unify how the docs are built in vagrant and in tox.

I looked at the makefile and the docs tox target and they are almost identical, the tox one is even running ./generate_db_schema. So I would just fix the zuul file.

Zlopez · 2021-07-26T07:52:21Z

anitya/templates/project_new.html

@@ -377,7 +377,7 @@ <h1>{{ context }} project</h1>
          $(btn).show(); $(btn + "-spinner").hide();
          alert(
              'Unable to retrieve the latest version from upstream!\n'
-              + 'ERROR: ' + res.responseJSON );
+              + 'ERROR: ' + JSON.stringify(res.responseJSON) );


I'm not that familiar with javascript, so this will be probably my error. Thanks for fixing this.

You are not the only one 😆
This is a very common mistake in error handlers.
The default string resulting from adding an object to string is the useless [Object object]
and it is even easier to accidentally write that kind of code
because e.g. console.log(object) actually prints something useful.

That's why people are using some JavaScript replacements on serious projects?

It would be nice to get rid of Javascript entirely, but I'm not frontend developer, so this is not my cup of tea.

Vagrant development environment setup failed during 'vagrant up' with the following errors during from task 'Build the Anitya documentation': > user-guide.rst:210:Inline strong start-string without end-string. > user-guide.rst:3:Duplicate explicit target name: \"sourceforge.net\" Like the errors say, the entry about 'Sourceforge (git)' was corrupted in two different ways: 1. Strong string was started with `**`, but never terminated. The fix is obvious. 2. The same document had two links using format '`text <url>`_', which is not allowed in reStructured Text. Fixed by using '__' in the second link, making it "anonymous". Signed-off-by: Otto Urpelainen <[email protected]>

Caused the page it was on malfunction in serious ways. Signed-off-by: Otto Urpelainen <[email protected]>

When Test Check failed in the Edit Project page, resulting error was displayed as '[Object object]'. This was a result of concatenating an object to string. Fixed by using JSON.stringify(). Signed-off-by: Otto Urpelainen <[email protected]>

softwarefactory-project-zuul · 2021-07-26T08:22:52Z

Build succeeded.

tox-lint : SUCCESS in 4m 37s
tox-format : SUCCESS in 4m 25s
tox-python37 : SUCCESS in 7m 46s
tox-python38 : SUCCESS in 8m 08s
anitya-tox-docs : SUCCESS in 4m 45s
tox-bandit : SUCCESS in 4m 00s
tox-diff-cover : SUCCESS in 7m 59s

oturpe · 2021-07-26T08:26:30Z

The changes are looking good, could you just add a news file to this PR?

Name it PR1144.bug and add it to news folder. The text could be something like Fix documentation and javascript issue`

Uh, sorry. I was not entirely sure if there is required or encouraged for every pull request. Fixed.

Zlopez · 2021-07-26T08:28:58Z

The changes are looking good, could you just add a news file to this PR?
Name it PR1144.bug and add it to news folder. The text could be something like Fix documentation and javascript issue`

Uh, sorry. I was not entirely sure if there is required or encouraged for every pull request. Fixed.

I don't create them, if this is only about fixing tests or some small changes in dev environment, but it's good to have them if this is anything that affects users of release-monitoring.org

Zlopez · 2021-07-26T08:29:34Z

Let me first fix the documentation build so I can see that it really fails, then I will merge this PR.

Zlopez · 2021-07-26T09:25:08Z

The Zuul PR is #1147

Zlopez · 2021-07-26T10:13:43Z

The PR #1147 failed, so let's merge this one and see if it will pass.

LenkaSeg · 2021-07-26T10:48:04Z

@oturpe Thanks for the fixes! I missed it totally.

oturpe requested a review from a team as a code owner July 25, 2021 10:37

oturpe force-pushed the fix-doc-build-failure branch from a0d889b to 026691f Compare July 25, 2021 17:43

oturpe force-pushed the fix-doc-build-failure branch from 026691f to 4636f69 Compare July 25, 2021 19:07

oturpe changed the title ~~Vagrant development environment setup failed during 'vagrant up'~~ Fix multiple small (but sometimes serious) issues Jul 25, 2021

Zlopez requested changes Jul 26, 2021

View reviewed changes

oturpe added 4 commits July 26, 2021 11:13

Fix corrupted javascript

98ec617

Caused the page it was on malfunction in serious ways. Signed-off-by: Otto Urpelainen <[email protected]>

Display error correctly when Test Check fails

531a9bd

When Test Check failed in the Edit Project page, resulting error was displayed as '[Object object]'. This was a result of concatenating an object to string. Fixed by using JSON.stringify(). Signed-off-by: Otto Urpelainen <[email protected]>

Add pull request news entry

ffad6dd

oturpe force-pushed the fix-doc-build-failure branch from 4636f69 to ffad6dd Compare July 26, 2021 08:14

Zlopez approved these changes Jul 26, 2021

View reviewed changes

mergify bot merged commit ff3e2db into fedora-infra:master Jul 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix multiple small (but sometimes serious) issues #1144

Fix multiple small (but sometimes serious) issues #1144

oturpe commented Jul 25, 2021 •

edited

Loading

softwarefactory-project-zuul bot commented Jul 25, 2021

softwarefactory-project-zuul bot commented Jul 25, 2021

softwarefactory-project-zuul bot commented Jul 25, 2021

Zlopez left a comment

Zlopez Jul 26, 2021

oturpe Jul 26, 2021

Zlopez Jul 26, 2021

Zlopez Jul 26, 2021

Zlopez Jul 26, 2021

oturpe Jul 26, 2021

abitrolly Jul 26, 2021

Zlopez Jul 26, 2021

softwarefactory-project-zuul bot commented Jul 26, 2021

oturpe commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

LenkaSeg commented Jul 26, 2021

Fix multiple small (but sometimes serious) issues #1144

Fix multiple small (but sometimes serious) issues #1144

Conversation

oturpe commented Jul 25, 2021 • edited Loading

Vagrant development environment setup failed during 'vagrant up'

Fix corrupted javascript

Display error correctly when Test Check fails

softwarefactory-project-zuul bot commented Jul 25, 2021

softwarefactory-project-zuul bot commented Jul 25, 2021

softwarefactory-project-zuul bot commented Jul 25, 2021

Zlopez 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

softwarefactory-project-zuul bot commented Jul 26, 2021

oturpe commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

Zlopez commented Jul 26, 2021

LenkaSeg commented Jul 26, 2021

oturpe commented Jul 25, 2021 •

edited

Loading