feat: Implement --use-index & SPA flags #374

Antosser · 2023-10-29T22:16:09Z

Implemented the --use-index flag. If the path matches a directory and an index.html is found inside, the index.html gets sent instead of the explorer of the directory.

Implemented the --spa flag. If a file/directory is not found, the index.html in the root gets sent. The existence of index.html in the root is also checked at startup. An error is thrown otherwise:

        if config.spa() {
            let mut index_html = config.root_dir();
            index_html.push("index.html");

            if !index_html.exists() {
                eprintln!(
                    "{}",
                    "SPA flag is enabled, but index.html in root does not exist. Quitting...".red()
                );
                exit(1);
            }
        }

The docs were updated to match the new changes

LeoBorai · 2023-10-30T03:36:26Z

@Antosser can we have 2 PRs for this? And tests as well please?

Its easier to review and to ensure everything is working as expected.

Antosser · 2023-10-30T10:33:10Z

@Antosser can we have 2 PRs for this? And tests as well please?

Its easier to review and to ensure everything is working as expected.

To split this up into 2 PRs, the second will need to come after the first one. They cannot coexist, because of potential merge conflicts. It would be faster to leave this PR as is. I can write test though.

Antosser · 2023-10-30T12:09:12Z

Why do the integration tests not get ran?

Edit: And why do 7 of them fail

Antosser · 2023-10-30T20:21:49Z

An integration test is the right type of test to test the --spa and --use-index flag. However, I do not understand why they do not get run if you do cargo test. Also, given from what I've read, the #[cfg(test)], the mod ... {, and the mod.rs file inside tests, seem unnecessary, see the docs

Antosser · 2023-11-11T21:32:10Z

I still need an answer

LeoBorai · 2023-11-18T18:22:57Z

An integration test is the right type of test to test the --spa and --use-index flag. However, I do not understand why they do not get run if you do cargo test. Also, given from what I've read, the #[cfg(test)], the mod ... {, and the mod.rs file inside tests, seem unnecessary, see the docs

Hey @Antosser!

I recommend reading the workflow files to understand how every test is executed.

With regards to the organization of tests, I suggest leaving them as they are and discuss about them separately.

Lately, for E2E testing I would use something like Bats. I could set in up for you and leave a couple examples for you to follow and apply on this PR.

Antosser · 2023-11-18T19:50:53Z

I recommend reading the workflow files to understand how every test is executed.

Do you mean the GitHub workflow files or the scripts?

Lately, for E2E testing I would use something like Bats

Bats, as in .bat files? Couldn't finds anything else with this name

Provide tests workflow for CI --- ### Dependants - [ ] http-server-rs#402 - [ ] http-server-rs#374

Antosser · 2023-11-22T20:10:54Z

@EstebanBorai

I want to say that the reason people use this app is that it is the rust alternative to NPM's http-server. People expect, that it is blazingly fast, very reliable, easy to use, and feature-rich. It has to represent the Rust community very well. That's why I want to make this app as friendly and easy to use as possible.

The purpose of NPM's http-server is to quickly set up an HTTP server to host HTML files, and that's the default. In my opinion, we should make that the default too and replace the --index flag with an --explorer flag.

I really want to add new features, but have no interest in writing non-rust bats tests. Can you please write them, so I can move on to other features without worrying about merge conflicts? Also, please consider using index.htmls by default.

Thanks for the overall help!

…nto indexhtml

Antosser · 2024-02-24T23:13:32Z

I love git

LeoBorai · 2024-02-25T00:55:15Z

I love git

LOL

LeoBorai · 2024-02-25T01:27:51Z

@Antosser can we have workflow changes in a separato PR please?

LeoBorai

Lets move changes not related to SPA/index to a separate PR please!

LeoBorai · 2024-02-25T01:28:35Z

.github/workflows/build.yml

Move to a scoped PR please!

LeoBorai · 2024-02-25T01:28:42Z

.github/workflows/clippy.yml

Move to a scoped PR please!

LeoBorai · 2024-02-25T01:28:47Z

.github/workflows/fmt.yml

Move to a scoped PR please!

LeoBorai · 2024-02-25T01:28:54Z

.github/workflows/test.yml

Move to a scoped PR please!

LeoBorai · 2024-02-25T01:29:27Z

LICENSE-MIT

Can we have a specific PR for these updates? Im trying to narrow down this PR scope.

I don't remember ever changing the license.

LeoBorai · 2024-02-25T01:29:54Z

README.md

I think its okay to add these changes as part of the LICENSE PR!

LeoBorai · 2024-02-25T01:31:02Z

Cargo.toml

@@ -58,6 +58,7 @@ tokio = { version = "1.29.1", features = [
 tokio-rustls = "0.23.4"
 toml = "0.7.6"
 humansize = "2.1.3"
+colored = "2.0.4"


Can we add colors in another PR? So we revisit all places and keep UI consistent?

Antosser · 2024-02-25T10:47:51Z

I never changed any of the workflow files, but it still looks like I changed them in this PR

LeoBorai · 2024-02-25T12:40:57Z

I never changed any of the workflow files, but it still looks like I changed them in this PR

I think it has a couple issues while rebasing!

LeoBorai · 2024-02-25T12:44:13Z

Perhaphs you can delete those workflow files from your PR?

Antosser · 2024-02-25T20:07:30Z

Perhaphs you can delete those workflow files from your PR?

If I delete them, and you merge the PR, they will also disappear in the main branch.
At this point, I have no idea how to fix this PR. I'll just copy/paste the changes I actually made into a new PR

Antosser · 2024-02-25T21:02:52Z

@EstebanBorai Can I make the --index flag the default and replace it with a --explorer flag? Better to know now before making changes I would have to change again later

LeoBorai · 2024-02-25T21:05:10Z

@EstebanBorai Can I make the --index flag the default and replace it with a --explorer flag? Better to know now before making changes I would have to change again later

I would stick to current approach for now. I dont want to introduce unexpected changes for v0.

I have plans to move into Axum for a v1. I think this change of behavior will fit just fine when on Axum!

LeoBorai · 2024-02-25T21:05:36Z

Perhaphs you can delete those workflow files from your PR?

If I delete them, and you merge the PR, they will also disappear in the main branch. At this point, I have no idea how to fix this PR. I'll just copy/paste the changes I actually made into a new PR

SGTM

Antosser · 2024-02-25T21:11:38Z

@EstebanBorai Can I make the --index flag the default and replace it with a --explorer flag? Better to know now before making changes I would have to change again later

I would stick to current approach for now. I dont want to introduce unexpected changes for v0.

I have plans to move into Axum for a v1. I think this change of behavior will fit just fine when on Axum!

aight

Antosser added 9 commits October 29, 2023 00:22

Add --use_index flag

2f88819

Fancier error messages

d03de4d

Run cargo clippy --fix

d2b0a6d

Reduce code redundancy

9dc7e3e

Add SPA flag

5a6e2aa

Throw error message if SPA is enabled, but index.html doesn't exist

8d9d2e0

Run cargo clippy --fix

f2c0945

Updated docs to match SPA flag

26c0d42

Remove accidental newline

3f35255

Antosser added 3 commits October 30, 2023 11:36

Remove yet another accidental newline

9b4aec8

Write cli test for -i, -q, --spa, -use-index

be3b5b5

Add test for use_index and spa prop in config

2eefd39

Antosser added 2 commits November 15, 2023 01:47

Merge branch 'main' into indexhtml

4436fe8

Remove unresolved import

e0ef7db

Antosser mentioned this pull request Nov 18, 2023

[Feature Request] Unnecessary getters on Config sturct #401

Closed

LeoBorai mentioned this pull request Nov 18, 2023

chore: setup bats for e2e tests #403

Merged

2 tasks

LeoBorai and others added 3 commits November 19, 2023 00:56

Fix typos in README

f26fdf1

Rename --use-index flag to --index

0cf15f3

Antosser added 3 commits November 23, 2023 22:45

Run cargo clippy --fix

0cc0274

Run cargo fmt

394e604

Antosser added 14 commits February 24, 2024 23:59

Add SPA flag

ab6d096

Throw error message if SPA is enabled, but index.html doesn't exist

44b4cbe

Run cargo clippy --fix

f8f36b0

Updated docs to match SPA flag

9fae109

Remove yet another accidental newline

8e47139

Write cli test for -i, -q, --spa, -use-index

c053f0a

Add test for use_index and spa prop in config

8e5f103

Remove unresolved import

24b464a

Fix typos in README

899ea3e

Rename --use-index flag to --index

d965d03

Run cargo clippy --fix

a320437

Fix clippy warnings & errors

c9ccb30

Run cargo fmt

26491f7

Merge branch 'indexhtml' of https://github.com/Antosser/http-server i…

4be97a4

…nto indexhtml

Remove duplicate dependency from Cargo.toml

d84febc

LeoBorai reviewed Feb 25, 2024

View reviewed changes

Remove colored

9291c83

Antosser closed this Feb 25, 2024

Antosser deleted the indexhtml branch February 27, 2024 17:49

feat: Implement --use-index & SPA flags #374

feat: Implement --use-index & SPA flags #374

Uh oh!

Conversation

Antosser commented Oct 29, 2023

Uh oh!

LeoBorai commented Oct 30, 2023

Uh oh!

Antosser commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Antosser commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Antosser commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Antosser commented Nov 11, 2023

Uh oh!

LeoBorai commented Nov 18, 2023

Uh oh!

Antosser commented Nov 18, 2023

Uh oh!

Antosser commented Nov 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Antosser commented Feb 24, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

LeoBorai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Antosser commented Feb 25, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

Antosser commented Feb 25, 2024

Uh oh!

Antosser commented Feb 25, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

LeoBorai commented Feb 25, 2024

Uh oh!

Antosser commented Feb 25, 2024

Uh oh!

Uh oh!

Antosser commented Oct 30, 2023 •

edited

Loading

Antosser commented Oct 30, 2023 •

edited

Loading

Antosser commented Oct 30, 2023 •

edited

Loading

Antosser commented Nov 22, 2023 •

edited

Loading